Repository navigation
Update PriceCharting clients and authentication security - #12
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Update both clients to handle the API token with increased redaction.
Token handling (
PriceChartingandAsyncPriceCharting)token: str | None = None. If it is omitted, the token is read from thePRICECHARTING_TOKENenvironment variable (TOKEN_KEY).ValueErrorwhen no token is found or the token is not 40 characters, so a bad token fails immediately instead of on the first request.SecretStrin a private_tokenso it shows as**********in debuggers and error reports.Request authentication (
_auth.py)_TokenAuthis anhttpx2.Authshared by both clients. It adds the token astto the query string forGETrequests and to the form body forPOSTrequests, as the API requires. It replaces any existingtand recalculatesContent-LengthandContent-TypeforPOSTbodies.Log redaction
t=<token>forGETrequests._REDACT_FILTERis a singlelogging.Filterthat each client attaches to thehttpx2logger. It rewrites the token tot=REDACTEDbefore any handler sees the record.Docs
ValueErrorcases and the logger filter.docs/index.mdhas new Authentication and Security sections. The Security section notes that the token is still visible in URLs to anything outside the library, such as proxies.Type of Change
Feature
Checklist
just lintpassesjust testpassesREADME.md,docs/,CLAUDE.md)